home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ktshp231.zip / REPORT.DOC < prev    next >
Text File  |  1992-09-15  |  9KB  |  204 lines
  1.                     AD HOC Report WRITER MODULE
  2.                
  3.  
  4.      Ad Hoc Report Writer requires very little from the user 
  5.   beyond pointing at a desired action and hitting the ENTER key.
  6.   It was designed this way from the start.
  7.      
  8.      Reports and mail label definitions created with Report Writer
  9.   can be saved, edited, and rerun at will.  All output can be 
  10.   sent to the printer, screen, or to a disk file.  Custom indexes
  11.   can be built from within Report for your report and label runs. 
  12.  
  13.    
  14.   ENVIRONMENT VARIABLE
  15.       
  16.       Report Writer is written in Clipper 5.01.  Since Clipper will
  17.   use expanded memory for indexing purposes it is standard practice to
  18.   include the following statment in your AUTOEXEC.BAT file if you should
  19.   experience corrupt indexes:
  20.       
  21.                            SET CLIPPER=E:0
  22.                       (or) SET CLIPPER=//E:0    
  23.  
  24.   Unlikely index corruption of this sort can occur with incompatible 
  25.   expanded memory managers.  This should alleviate any problems with
  26.   expanded memory you might encounter.
  27.            
  28.                  
  29.   *-------------------------------------------------------------------*    
  30.                                 MAIN MENU
  31.   *-------------------------------------------------------------------*    
  32.   
  33.   CREATING A REPORT DEFINITION FOR THE FIRST TIME
  34.   
  35.   Ad Hoc Report Writer creates three distinct types of reports. A single
  36.   file report uses just one primary file.  A relational report type one
  37.   uses both a primary and secondary file.  There is one record in the 
  38.   secondary file for each primary record.  A relational report type two
  39.   uses both a primary and secondary file.  There are multiple secondary 
  40.   records for each primary record.  Your data detemines which type of 
  41.   report you will need to create.
  42.   
  43.   Creating a report is essentially the same process for all report
  44.   types. First, the report type is chosen and then report parameters 
  45.   are entered. You can control things like the left margin, spaces 
  46.   between printed fields on the report, page width, page length, etc.
  47.   The only parameter that may be confusing to the you is the subtotal
  48.   parameter. 
  49.     
  50.   Say, for example, you have a file of customer purchases like
  51.   ORDER.DBF.  It is indexed on customer number and you are trying to 
  52.   total the purchases for each customer and want a grand total of all
  53.   purchases.  If you choose the subtotal option on the report parameter 
  54.   screen Ad Hoc Report Writer will print and sum all of the purchases
  55.   for customer 100, display a subtotal, space, and then begin printing
  56.   and summing the purchases by customer 200 and so forth.  Create a
  57.   single file report for ORDER.DBF with the subtotal option.  Total the
  58.   QTY and SELL fields for practice.  The subtotal option's use will then 
  59.   become clear.
  60.   
  61.   You choose your primary and secondary files from a scolling list.
  62.   You choose the fields you wish to include in the report from scrolling 
  63.   lists.  Nothing could be easier!  Just remember the following: 
  64.   
  65.    
  66.   1. A MAXIUM OF 27 FIELDS FROM EACH FILE MAY BE USED IN THE REPORT.
  67.   
  68.   2. THREE CALCULATED FIELDS MAY BE DEFINED PER FILE.
  69.   
  70.   3. MEMO FIELD PROCESSING IS LIMITED TO ONE MEMO FIELD IN A SINGLE FILE
  71.      REPORT.
  72.            
  73.   4. FIELDS APPEAR ON THE PRINTED REPORT IN THE ORDER IN WHICH THEY WERE
  74.      SELECTED.
  75.      
  76.   5. IF YOU DO NOT ENTER A COLUMN HEADING FOR A FIELD THE FIELD NAME WILL
  77.      BE USED AS A COLUMN HEADING ON THE REPORT.
  78.      
  79.   6. IF YOU ARE USING TOTALS, SUBTOTALS, AND/OR CALCULATED FIELDS EXPECT
  80.      YOUR REPORT TO BE WIDER THAN THE WIDTH OF THE SELECTED FIELDS ALONE.
  81.      EXTRA SPACE IS ALLOCATED TO A FIELD BEING TOTALLED AND TO A CALC 
  82.      FIELD BEYOND THAT WHICH IS DISPLAYED BY THE FIELD SELECTION SCREEN.
  83.         
  84.   7. WHEN CREATING RELATIONAL REPORTS OR WHEN SELECTING THE SUBTOTAL 
  85.      OPTION BE CERTAIN TO SELECT KEY FIELD OF PRIMARY FILE AS FIRST 
  86.      PRIMARY FIELD SELECTED!  (** Very Important **)     
  87.      
  88.   8. PRIMARY & SECONDARY FILE KEYS MUST BE COMPATIBLE WHEN CREATING 
  89.      RELATIONAL REPORTS.   (** Very Important **)           
  90.  
  91.   9. ALL OUTPUT CAN BE STOPPED WITH THE ESC KEY IF YOU DESIRE.
  92.  
  93.  
  94.   EXECUTING A REPORT DEFINITION 
  95.   
  96.   Simply select the report definition from the scrolling list by
  97.   striking enter.  You will have an opportunity to edit the report     
  98.   parameters you entered when you created it.  You can also edit or 
  99.   create a query for the report and save it under the same or differ-
  100.   ent name.  Output for all reports can go to the printer, screen, or
  101.   to a disk file.
  102.  
  103.  
  104.         
  105.   *-------------------------------------------------------------------*    
  106.                               MAIL LABELS
  107.   *-------------------------------------------------------------------*  
  108.  
  109.   
  110.   CREATING A MAIL LABEL DEFINITION FOR THE FIRST TIME     
  111.  
  112.   Ad Hoc Report Writer permits the creation of standard, large,
  113.   or cheshire format mailing labels.  Simply take the Mailing Label 
  114.   option from the Main menu.  You will be asked to choose a
  115.   primary file and primary file index.  Next you will be given the
  116.   opportunity to query the primary file if you desire. In this manner
  117.   you can select to filter out certain zipcodes or cities according to 
  118.   your preferences and needs.
  119.   
  120.   You will then enter the label module.  Choose the create option from 
  121.   within the label module.  Assign the label file a unique and meaningful 
  122.   name. Select the modify contents option.  Press F2 to choose field names 
  123.   for each line of the label you wish to create.  BE SURE TO PLACE THE
  124.   CURSOR AT THE BEGINNING OF THE LINE TO WHICH YOU ARE APPENDING FIELD
  125.   NAMES!  Follow the prompts and press F10 when you are done.  Be sure to
  126.   choose the proper format and dimensions from within the dimensions
  127.   selection.
  128.  
  129.   By experimenting with the other options you'll find that you can 
  130.   tag select records and print only them if you choose.  You can now print
  131.   your mail labels and recall the new label definition you've just created
  132.   whenever you wish. Just remember the following:  
  133.  
  134.   1. Be certain to choose the proper format and dimension from within 
  135.      the dimension option.  You can make adjustments to the default 
  136.      sizes as you wish.  Maximum label size is 24 X 60.
  137.    
  138.   2. Create index files keyed on the fields by which you want to order 
  139.      your label printout.  If you want labels to be printed in zipcode
  140.      order then be sure to create an index file keyed on zipcode etc.
  141.    
  142.   3. Make use of the test pattern and correct your alignment before 
  143.      beginning a large label run. (** Very Important **)
  144.    
  145.   4. Make use of the query builder to select or filter your primary 
  146.      file when printing labels if you don't wish to create a label for
  147.      every record in your file.   
  148.    
  149.   5. You can pause printer output with ALT-C if your label run jams in
  150.      the printer.  It's not the most sophisticated way to do so, but
  151.      it certainly works.  ESCAPE will ABORT a label printout.
  152.    
  153.   6. A sample label definition (MAIL.LBL) is provided on your diskette.  
  154.      You can experiment with changes and printing by selecting it. First
  155.      you select the Process Mailing Labels option from the Main Menu. 
  156.      Then select MAIL.DBF and MAIL.NTX as your primary file and index.  
  157.  
  158.   7. The copies parameter will determine how many labels for each record
  159.      are printed.
  160.         
  161.   8. The blank lines parameter will control the printing of blank lines
  162.      in your label definition.  Blank lines can be useful for spacers
  163.      when printing large labels.
  164.   
  165.   9. If you build a new label or edit an existing one and utilize the
  166.      automatic field name selector, be sure to place the cursor at the
  167.      BEGINNING of the line you are appending field names to!  Experiment
  168.      with this and you'll see why!
  169.  
  170.  
  171.    
  172.   CREATE A NEW INDEX FILE
  173.  
  174.   Simply select this option from the Main Menu. Select a primary file.
  175.   Then select the field(s) you wish to index on. The last step in creating
  176.   a new index is giving the new index file a name. That's all!  The Report
  177.   Writer does the rest!
  178.    
  179.   ( ** VERY IMPORTANT ** )
  180.   1. RPT writer converts numeric and date fields to character values when 
  181.   you build an index with them. RPT writer ensures the proper ordering of
  182.   values in this manner. Character indexes are completely compatible and 
  183.   need not be rebuilt. This conversion of numeric & date fields to string
  184.   values is standard practice and enables you to build compound keys with
  185.   mixed data types. These indexes are not backwards compatible with dBASE
  186.   but it is a simple procedure to rebuild an index file using dBASE if you 
  187.   must for reasons of compatiblity with other programs which access your
  188.   data files.
  189.  
  190.  
  191.   CHANGE THE DIRECTORY
  192.  
  193.   This option enables you to select any directory on your disk 
  194.   in which you you might have database files.  RPT Writer will ask you 
  195.   which directory you'd like to enter.  Enter the name.  If you make
  196.   a spelling error RPT Writer will report that it is not possible to
  197.   enter the directory you keyed in.
  198.  
  199.   
  200.              
  201.                             **  END OF FILE ***   
  202.                           
  203.                           
  204.